<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: XMLSerializer.html 878 2015-04-17 01:32:03Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.kv.util;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.InputStream;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.io.OutputStream;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.io.Writer;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.util.Iterator;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import javax.xml.namespace.QName;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import javax.xml.stream.XMLInputFactory;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import javax.xml.stream.XMLOutputFactory;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import javax.xml.stream.XMLStreamException;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import javax.xml.stream.XMLStreamReader;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import javax.xml.stream.XMLStreamWriter;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.dellroad.stuff.xml.IndentXMLStreamWriter;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.jsimpledb.kv.KVPair;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.jsimpledb.kv.KVStore;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.jsimpledb.util.AbstractXMLStreaming;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.jsimpledb.util.ByteUtil;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Utility methods for serializing and deserializing the contents of a {@link org.jsimpledb.kv.KVStore} to/from XML.<a name="line.29"></a>
<span class="sourceLineNo">030</span> *<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * The XML has a simple format; empty values may be omitted:<a name="line.32"></a>
<span class="sourceLineNo">033</span> *  &lt;pre&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> *  &amp;lt;xml version="1.0" encoding="UTF-8"?&amp;gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> *  &amp;lt;entries&amp;gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> *      &amp;lt;entry&amp;gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> *          &amp;lt;key&amp;gt;013f7b&amp;lt;/key&amp;gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> *          &amp;lt;value&amp;gt;5502&amp;lt;/value&amp;gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> *      &amp;lt;/entry&amp;gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> *      &amp;lt;entry&amp;gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> *          &amp;lt;key&amp;gt;ee7698&amp;lt;/key&amp;gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> *      &amp;lt;/entry&amp;gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> *      ...<a name="line.44"></a>
<span class="sourceLineNo">045</span> *  &amp;lt;/entries&amp;gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> *  &lt;/pre&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span>public class XMLSerializer extends AbstractXMLStreaming {<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span>    public static final QName ENTRIES_TAG = new QName("entries");<a name="line.50"></a>
<span class="sourceLineNo">051</span>    public static final QName ENTRY_TAG = new QName("entry");<a name="line.51"></a>
<span class="sourceLineNo">052</span>    public static final QName KEY_TAG = new QName("key");<a name="line.52"></a>
<span class="sourceLineNo">053</span>    public static final QName VALUE_TAG = new QName("value");<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>    private final KVStore kv;<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span>    /**<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * Constructor.<a name="line.58"></a>
<span class="sourceLineNo">059</span>     *<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * @param kv key/value store on which to operate<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * @throws IllegalArgumentException if {@code kv} is null<a name="line.61"></a>
<span class="sourceLineNo">062</span>     */<a name="line.62"></a>
<span class="sourceLineNo">063</span>    public XMLSerializer(KVStore kv) {<a name="line.63"></a>
<span class="sourceLineNo">064</span>        if (kv == null)<a name="line.64"></a>
<span class="sourceLineNo">065</span>            throw new IllegalArgumentException("null kv");<a name="line.65"></a>
<span class="sourceLineNo">066</span>        this.kv = kv;<a name="line.66"></a>
<span class="sourceLineNo">067</span>    }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span>    /**<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * Import key/value pairs into the {@link KVStore} associated with this instance from the given XML input.<a name="line.70"></a>
<span class="sourceLineNo">071</span>     *<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * &lt;p&gt;<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * The {@code input} is not closed by this method.<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * &lt;/p&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span>     *<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * @param input XML input<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * @throws XMLStreamException if an error occurs<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * @throws IllegalArgumentException if {@code input} is null<a name="line.78"></a>
<span class="sourceLineNo">079</span>     */<a name="line.79"></a>
<span class="sourceLineNo">080</span>    public void read(InputStream input) throws XMLStreamException {<a name="line.80"></a>
<span class="sourceLineNo">081</span>        if (input == null)<a name="line.81"></a>
<span class="sourceLineNo">082</span>            throw new IllegalArgumentException("null input");<a name="line.82"></a>
<span class="sourceLineNo">083</span>        this.read(XMLInputFactory.newFactory().createXMLStreamReader(input));<a name="line.83"></a>
<span class="sourceLineNo">084</span>    }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span>    /**<a name="line.86"></a>
<span class="sourceLineNo">087</span>     * Import key/value pairs into the {@link KVStore} associated with this instance from the given XML input.<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * This method expects to see an opening {@code &lt;entries&gt;} as the next event (not counting whitespace, comments, etc.),<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * which is then consumed up through the closing {@code &lt;/entries&gt;} event. The {@code reader} is not closed by this method.<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * Therefore, this tag could be part of a larger XML document.<a name="line.90"></a>
<span class="sourceLineNo">091</span>     *<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * @param reader XML reader<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * @throws XMLStreamException if an error occurs<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * @throws IllegalArgumentException if {@code reader} is null<a name="line.94"></a>
<span class="sourceLineNo">095</span>     */<a name="line.95"></a>
<span class="sourceLineNo">096</span>    public void read(XMLStreamReader reader) throws XMLStreamException {<a name="line.96"></a>
<span class="sourceLineNo">097</span>        if (reader == null)<a name="line.97"></a>
<span class="sourceLineNo">098</span>            throw new IllegalArgumentException("null reader");<a name="line.98"></a>
<span class="sourceLineNo">099</span>        this.expect(reader, false, ENTRIES_TAG);<a name="line.99"></a>
<span class="sourceLineNo">100</span>        while (this.expect(reader, true, ENTRY_TAG)) {<a name="line.100"></a>
<span class="sourceLineNo">101</span>            this.expect(reader, false, KEY_TAG);<a name="line.101"></a>
<span class="sourceLineNo">102</span>            byte[] key;<a name="line.102"></a>
<span class="sourceLineNo">103</span>            try {<a name="line.103"></a>
<span class="sourceLineNo">104</span>                key = ByteUtil.parse(reader.getElementText());<a name="line.104"></a>
<span class="sourceLineNo">105</span>            } catch (IllegalArgumentException e) {<a name="line.105"></a>
<span class="sourceLineNo">106</span>                throw new XMLStreamException("invalid hexadecimal key", reader.getLocation(), e);<a name="line.106"></a>
<span class="sourceLineNo">107</span>            }<a name="line.107"></a>
<span class="sourceLineNo">108</span>            if (!this.expect(reader, true, VALUE_TAG)) {<a name="line.108"></a>
<span class="sourceLineNo">109</span>                this.kv.put(key, ByteUtil.EMPTY);<a name="line.109"></a>
<span class="sourceLineNo">110</span>                continue;                           // closing &lt;/entry&gt; tag alread read<a name="line.110"></a>
<span class="sourceLineNo">111</span>            }<a name="line.111"></a>
<span class="sourceLineNo">112</span>            byte[] value;<a name="line.112"></a>
<span class="sourceLineNo">113</span>            try {<a name="line.113"></a>
<span class="sourceLineNo">114</span>                value = ByteUtil.parse(reader.getElementText());<a name="line.114"></a>
<span class="sourceLineNo">115</span>            } catch (IllegalArgumentException e) {<a name="line.115"></a>
<span class="sourceLineNo">116</span>                throw new XMLStreamException("invalid hexadecimal value", reader.getLocation(), e);<a name="line.116"></a>
<span class="sourceLineNo">117</span>            }<a name="line.117"></a>
<span class="sourceLineNo">118</span>            this.kv.put(key, value);<a name="line.118"></a>
<span class="sourceLineNo">119</span>            this.expectClose(reader);               // read closing &lt;/entry&gt; tag<a name="line.119"></a>
<span class="sourceLineNo">120</span>        }<a name="line.120"></a>
<span class="sourceLineNo">121</span>    }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span>    /**<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * Export all key/value pairs from the {@link KVStore} associated with this instance to the given output.<a name="line.124"></a>
<span class="sourceLineNo">125</span>     *<a name="line.125"></a>
<span class="sourceLineNo">126</span>     * &lt;p&gt;<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * The {@code output} is not closed by this method.<a name="line.127"></a>
<span class="sourceLineNo">128</span>     * &lt;/p&gt;<a name="line.128"></a>
<span class="sourceLineNo">129</span>     *<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * @param output XML output; will not be closed by this method<a name="line.130"></a>
<span class="sourceLineNo">131</span>     * @param indent true to indent output, false for all on one line<a name="line.131"></a>
<span class="sourceLineNo">132</span>     * @throws XMLStreamException if an error occurs<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * @throws IllegalArgumentException if {@code output} is null<a name="line.133"></a>
<span class="sourceLineNo">134</span>     */<a name="line.134"></a>
<span class="sourceLineNo">135</span>    public void write(OutputStream output, boolean indent) throws XMLStreamException {<a name="line.135"></a>
<span class="sourceLineNo">136</span>        if (output == null)<a name="line.136"></a>
<span class="sourceLineNo">137</span>            throw new IllegalArgumentException("null output");<a name="line.137"></a>
<span class="sourceLineNo">138</span>        XMLStreamWriter xmlWriter = XMLOutputFactory.newInstance().createXMLStreamWriter(output, "UTF-8");<a name="line.138"></a>
<span class="sourceLineNo">139</span>        if (indent)<a name="line.139"></a>
<span class="sourceLineNo">140</span>            xmlWriter = new IndentXMLStreamWriter(xmlWriter);<a name="line.140"></a>
<span class="sourceLineNo">141</span>        xmlWriter.writeStartDocument("UTF-8", "1.0");<a name="line.141"></a>
<span class="sourceLineNo">142</span>        this.write(xmlWriter, null, null);<a name="line.142"></a>
<span class="sourceLineNo">143</span>    }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span>    /**<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * Export all key/value pairs from the {@link KVStore} associated with this instance to the given writer.<a name="line.146"></a>
<span class="sourceLineNo">147</span>     *<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * &lt;p&gt;<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * The {@code writer} is not closed by this method.<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * &lt;/p&gt;<a name="line.150"></a>
<span class="sourceLineNo">151</span>     *<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * @param writer XML output; will not be closed by this method<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * @param indent true to indent output, false for all on one line<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * @throws XMLStreamException if an error occurs<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * @throws IllegalArgumentException if {@code writer} is null<a name="line.155"></a>
<span class="sourceLineNo">156</span>     */<a name="line.156"></a>
<span class="sourceLineNo">157</span>    public void write(Writer writer, boolean indent) throws XMLStreamException {<a name="line.157"></a>
<span class="sourceLineNo">158</span>        if (writer == null)<a name="line.158"></a>
<span class="sourceLineNo">159</span>            throw new IllegalArgumentException("null writer");<a name="line.159"></a>
<span class="sourceLineNo">160</span>        XMLStreamWriter xmlWriter = XMLOutputFactory.newInstance().createXMLStreamWriter(writer);<a name="line.160"></a>
<span class="sourceLineNo">161</span>        if (indent)<a name="line.161"></a>
<span class="sourceLineNo">162</span>            xmlWriter = new IndentXMLStreamWriter(xmlWriter);<a name="line.162"></a>
<span class="sourceLineNo">163</span>        xmlWriter.writeStartDocument("1.0");<a name="line.163"></a>
<span class="sourceLineNo">164</span>        this.write(xmlWriter, null, null);<a name="line.164"></a>
<span class="sourceLineNo">165</span>    }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span>    /**<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * Export a range of key/value pairs from the {@link KVStore} associated with this instance to the given XML output.<a name="line.168"></a>
<span class="sourceLineNo">169</span>     *<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * &lt;p&gt;<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * This method writes a start element as its first action, allowing the output to be embedded into a larger XML document.<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * Callers not embedding the output may with to precede invocation of this method with a call to<a name="line.172"></a>
<span class="sourceLineNo">173</span>     * {@link XMLStreamWriter#writeStartDocument writer.writeStartDocument()}.<a name="line.173"></a>
<span class="sourceLineNo">174</span>     * &lt;/p&gt;<a name="line.174"></a>
<span class="sourceLineNo">175</span>     *<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * &lt;p&gt;<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * The {@code writer} is not closed by this method.<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * &lt;/p&gt;<a name="line.178"></a>
<span class="sourceLineNo">179</span>     *<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * @param writer XML writer; will not be closed by this method<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * @param minKey minimum key (inclusive), or null for none<a name="line.181"></a>
<span class="sourceLineNo">182</span>     * @param maxKey maximum key (exclusive), or null for none<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * @throws XMLStreamException if an error occurs<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * @throws IllegalArgumentException if {@code writer} is null<a name="line.184"></a>
<span class="sourceLineNo">185</span>     */<a name="line.185"></a>
<span class="sourceLineNo">186</span>    public void write(XMLStreamWriter writer, byte[] minKey, byte[] maxKey) throws XMLStreamException {<a name="line.186"></a>
<span class="sourceLineNo">187</span>        if (writer == null)<a name="line.187"></a>
<span class="sourceLineNo">188</span>            throw new IllegalArgumentException("null writer");<a name="line.188"></a>
<span class="sourceLineNo">189</span>        writer.setDefaultNamespace(ENTRIES_TAG.getNamespaceURI());<a name="line.189"></a>
<span class="sourceLineNo">190</span>        writer.writeStartElement(ENTRIES_TAG.getNamespaceURI(), ENTRIES_TAG.getLocalPart());<a name="line.190"></a>
<span class="sourceLineNo">191</span>        for (Iterator&lt;KVPair&gt; i = this.kv.getRange(minKey, maxKey, false); i.hasNext(); ) {<a name="line.191"></a>
<span class="sourceLineNo">192</span>            writer.writeStartElement(ENTRY_TAG.getNamespaceURI(), ENTRY_TAG.getLocalPart());<a name="line.192"></a>
<span class="sourceLineNo">193</span>            final KVPair pair = i.next();<a name="line.193"></a>
<span class="sourceLineNo">194</span>            this.writeElement(writer, KEY_TAG, pair.getKey());<a name="line.194"></a>
<span class="sourceLineNo">195</span>            final byte[] value = pair.getValue();<a name="line.195"></a>
<span class="sourceLineNo">196</span>            if (value.length &gt; 0)<a name="line.196"></a>
<span class="sourceLineNo">197</span>                this.writeElement(writer, VALUE_TAG, value);<a name="line.197"></a>
<span class="sourceLineNo">198</span>            writer.writeEndElement();<a name="line.198"></a>
<span class="sourceLineNo">199</span>        }<a name="line.199"></a>
<span class="sourceLineNo">200</span>        writer.writeEndElement();<a name="line.200"></a>
<span class="sourceLineNo">201</span>        writer.flush();<a name="line.201"></a>
<span class="sourceLineNo">202</span>    }<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span>// Internal methods<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span>    private void writeElement(XMLStreamWriter writer, QName element, byte[] value) throws XMLStreamException {<a name="line.206"></a>
<span class="sourceLineNo">207</span>        this.writeElement(writer, element, ByteUtil.toString(value));<a name="line.207"></a>
<span class="sourceLineNo">208</span>    }<a name="line.208"></a>
<span class="sourceLineNo">209</span>}<a name="line.209"></a>
<span class="sourceLineNo">210</span><a name="line.210"></a>




























































</pre>
</div>
</body>
</html>
